package jmine.tec.services.annotations;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Representa uma propriedade que o serviço precisa para ser executado. Se o {@link #fieldName()} for omitido, vai usar o nome da
 * propriedade se for um 'setter' ou usar o próprio nome do método caso contrário.
 */
@Documented
@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
public @interface Input {

    /**
     * Nome do campo na origem de dados. Se não especicado, vai usar o nome do campo.
     */
    String fieldName() default "";

    /**
     * Verifica se a propriedade é requerida. O default é <code>true</code>.
     */
    boolean required() default true;

    /**
     * Se true, vai fazer cache
     */
    boolean cached() default false;

    /**
     * Valor padrao a ser usado
     */
    String defaultValue() default "";

}
